Vcenter Vcha Cluster NodeInfo

Vcenter Vcha Cluster NodeInfo
Vcenter Vcha Cluster NodeInfo

The Vcenter Vcha Cluster NodeInfo schema defines the configuration information for the active and passive nodes in the cluster.

This schema was added in vSphere API 6.7.1.

JSON Example
{
    "failover_ip": {
        "ip_family": "string",
        "ipv4": {
            "address": "string",
            "subnet_mask": "string",
            "prefix": 0
        },
        "ipv6": {
            "address": "string",
            "prefix": 0
        },
        "gateway_ip": "string"
    },
    "ha_ip": {
        "ip_family": "string",
        "ipv4": {
            "address": "string",
            "subnet_mask": "string",
            "prefix": 0
        },
        "ipv6": {
            "address": "string",
            "prefix": 0
        },
        "gateway_ip": "string"
    },
    "runtime": {
        "state": "string",
        "role": "string",
        "placement": {
            "management_vcenter_name": "string",
            "management_vcenter_server_guid": "string",
            "vm_name": "string",
            "datacenter": "string",
            "datacenter_name": "string",
            "host": "string",
            "host_name": "string",
            "cluster": "string",
            "cluster_name": "string",
            "ha_network": "string",
            "ha_network_name": "string",
            "ha_network_type": "string",
            "management_network": "string",
            "management_network_name": "string",
            "management_network_type": "string",
            "storage": {
                "datastore": "string",
                "datastore_name": "string"
            },
            "bios_uuid": "string"
        }
    }
}
failover_ip
Optional

Failover IP address that this node will assume after the failover to serve client requests. Each failover node can have a different failover IP address.
The active node's management vCenter server credentials are not required to populate Vcenter Vcha Cluster NodeInfo.failover_ip.

This property was added in vSphere API 6.7.1.

If missing or null, then it will assume the public IP address of the Active vCenter Server.

ha_ip
Required

VCHA Cluster network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network.
The active node's management vCenter server credentials are not required to populate this Vcenter Vcha Cluster NodeInfo.ha_ip.

This property was added in vSphere API 6.7.1.

runtime
Optional

Runtime information for the node in the VCHA Cluster.
The active node's management vCenter server credentials are required to populate some properties of Vcenter Vcha Cluster NodeInfo.runtime.

This property was added in vSphere API 6.7.1.

If missing or null, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet.